WOM Work Order Status Update (V1)
Content
Overview
The WOM work order status API allows you to update the work order status at the completion of a work order job.
Method
The following REST method is available:
- Updating the work order status
Requirements
Authorization API calls All API call request to ideabiz.lk required Authorization headers. Please refer the Token Management (http://docs.ideabiz.lk/Getting_Started/Token_Manegment) document for Authorization.
Request Header
Content-Type: application/json
Authorization: Bearer [access token]
Accept: application/json
Sample Request Header
Content-Type: application/json
Authorization: Bearer a92ba8hjgjhgjh3fa1609cabcd79
Accept: application/json
Request
Given below is a sample request of the send service.
URL
https://ideabiz.lk/apicall/WomWoStatusUpdate/V1.0/{channel}
Sample URL
https://ideabiz.lk/apicall/WomWoStatusUpdate/V1.0/WOM
Method
PUT
Body
{
"OrderId": 421,
"Status": "CLOSED",
"ClosedUser": "WOM_ADMIN"
}
Given below are the Request parameters for the Work Order Status Update.
|
Parameter Name |
Description |
Type |
Mandatory/Optional |
|
OrderId |
This is the unique work order ID. |
Numeric |
Mandatory |
|
Status |
This is the status of the work order. The possible work order statuses are Closed, Closed AP, Closed ERF, Failed, Incomplete, Initial, Assigned and On Hold. |
String |
Mandatory |
|
ClosedUser |
This is the work order closed user. |
String |
Mandatory, if the status is Closed, Closed AP, Closed ERF, Failed. |
|
Reason |
This is the reason that requires to be mentioned when a work order status is updating as Incomplete, On Hold, Initial, Failed. |
String |
Mandatory, if the status is Incomplete, On Hold, Initial, Failed. |
Response
Status code : 201
{
"Description": "Successfully updated the workorder status",
"OrderId": "421"
}